com.highdeal.rangetable.hci
Class CommonRangeTableModel

java.lang.Object
  com.highdeal.hci.HCIModelAdapter
      com.highdeal.chrono.hci.BaseChronologyModel<RangeTableRowPeriodObjectModel>
          com.highdeal.rangetable.hci.CommonRangeTableModel

All Implemented Interfaces:

ITagNameProvider, IXMLMarshallable, XMLMapping, XMLMarshallable

Direct Known Subclasses:

RangeTableModel, SubscriberRangeTableModel

public abstract class CommonRangeTableModel
extends BaseChronologyModel<RangeTableRowPeriodObjectModel>
implements XMLMapping

This abstract Java class facilitates the handling of range tables and subscriber range tables in master data managed by the connected SAP CC Core Server system and stored in its back-end database system.

Structure

Rows

This model defines the common structure of range tables and subscriber range tables in Java technology; it contains period-defined rows with input and output column filled. Each row is managed in a chronology that defines different versions of a row for different periods of time.

Custom data: Additional information

You can customize the data model by specifying some additional information.

Versions

This class defines the different versions of a range table (or subscriber range table). Refer to the CommonRangeTableRevisionModel class Consider the chronologies of rows.

Note

Refer to the SAP CC Library (Application Help) documentation in the SAP CC 4.0 product documentation for more information about:

• range tables and range table classes in master data (pricing catalog of the service provider)
• subscriber range tables in customer master data (information relating to the end customers of the service provider)

Consult the Features, Master Data, and Processes and Functions sections.

See Also:

RangeTableModel, SubscriberRangeTableModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:complexType name="CommonRangeTableType" abstract="true">
   <xs:sequence>
     <xs:element name="description" type="DescriptionType" minOccurs="0" maxOccurs="1" />
     <xs:element name="additionalInfo" type="AdditionalInfoType" minOccurs="0" maxOccurs="unbounded" />
     <xs:element name="period" type="RangeTableRowPeriodObjectType" minOccurs="1" maxOccurs="unbounded" />
   </xs:sequence>
   <xs:attribute name="id" type="xs:string" />
   <xs:attribute name="rangeTableClassId" type="xs:string" />
 </xs:complexType>

Constructor Summary

CommonRangeTableModel()

Method Summary

void	addCharacterData(java.lang.String CData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.util.List<AdditionalInfoModel>	getAdditionalInfoList() Gets the list of information dedicated to external system.
java.lang.Class<?>	getClass(java.lang.String nsUri, java.lang.String tag, XMLAttributes atts) Returns the Java class for a specified XML tag and its attributes in a namespace.
java.lang.String	getDescription() Gets the comprehensive description of the range table.
java.lang.String	getId() Gets the range table identifier.
java.lang.String	getRangeTableClassId() Gets the range table class code used by this instance.
void	marshalAttributes(XMLOutputter output) Gives an XML representation of the attributes of an object.
void	marshalChildren(XMLOutputter output) Gives an XML representation of the child objects of an object.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setDescription(java.lang.String description) Sets the comprehensive description of the range table.
void	setId(java.lang.String id) Sets the identifier of the range table.
void	setRangeTableClassId(java.lang.String rangeTableClassId) Sets the range table class code that contains the table scheme.

Methods inherited from class com.highdeal.chrono.hci.BaseChronologyModel

getPeriod, getPeriods, getTagName

Methods inherited from class com.highdeal.hci.HCIModelAdapter

marshal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommonRangeTableModel

public CommonRangeTableModel()

Method Detail

getId

public java.lang.String getId()

Gets the range table identifier.

Returns:

A string that contains the identifier of the range table

setId

public void setId(java.lang.String id)

Sets the identifier of the range table.

Parameters:

id - The identifier to set to the range table

getRangeTableClassId

public java.lang.String getRangeTableClassId()

Gets the range table class code used by this instance.

Returns:

A string that contains the range table class identifier to recover the scheme of the table

See Also:

RangeTableClassModel

setRangeTableClassId

public void setRangeTableClassId(java.lang.String rangeTableClassId)

Sets the range table class code that contains the table scheme.

Parameters:

rangeTableClassId - The identifier of the range table class to use

getDescription

public java.lang.String getDescription()

Gets the comprehensive description of the range table. Allow a better understanding about this range table.

Returns:

The textdescription of the range table

setDescription

public void setDescription(java.lang.String description)

Sets the comprehensive description of the range table. Allow a better understanding about this range table.

Parameters:

description - The text description of the range table

getAdditionalInfoList

public java.util.List<AdditionalInfoModel> getAdditionalInfoList()

Gets the list of information dedicated to external system. The designer of the range table adds information allowing an external system to search its specific range table. An additional information is a property defined by its name and its value.

Returns:

The list of information dedicated to external system

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Overrides:

addChild in class BaseChronologyModel<RangeTableRowPeriodObjectModel>

Parameters:

tagName - The name of tag for the child

child - The child to be added

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Overrides:

setAttributes in class BaseChronologyModel<RangeTableRowPeriodObjectModel>

Parameters:

atts - The XML attributes of the current element

addCharacterData

public void addCharacterData(java.lang.String CData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Overrides:

addCharacterData in class BaseChronologyModel<RangeTableRowPeriodObjectModel>

Parameters:

CData - The character data to be added

marshalAttributes

public void marshalAttributes(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the attributes of an object.

Specified by:

marshalAttributes in interface IXMLMarshallable

Overrides:

marshalAttributes in class BaseChronologyModel<RangeTableRowPeriodObjectModel>

Parameters:

output - The XML output to marshal the object attributes into

marshalChildren

public void marshalChildren(XMLOutputter output)

Description copied from interface: IXMLMarshallable

Gives an XML representation of the child objects of an object.

Specified by:

marshalChildren in interface IXMLMarshallable

Overrides:

marshalChildren in class BaseChronologyModel<RangeTableRowPeriodObjectModel>

Parameters:

output - The XML output to marshal the child objects into

getClass

public java.lang.Class<?> getClass(java.lang.String nsUri,
                                   java.lang.String tag,
                                   XMLAttributes atts)

Description copied from interface: XMLMapping

Returns the Java class for a specified XML tag and its attributes in a namespace.

Specified by:

getClass in interface XMLMapping

Parameters:

nsUri - The unique resource identifier of the namespace of the XML tag

tag - The local part of the XML tag

atts - The attributes of the XML tag

Returns:

A Java class with a default constructor